/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.netbeans.modules.php.editor.index;

import org.netbeans.modules.csl.api.ElementKind;
import org.netbeans.modules.php.editor.PredefinedSymbols;

/**
 *
 * @author tomslot
 */
public class PredefinedSymbolElement extends PHPElement {
    private String symbolName;

    public PredefinedSymbolElement(String symbolName) {
        this.symbolName = symbolName;
    }

    @Override
    public String getName() {
        return symbolName;
    }

    @Override
    public ElementKind getKind() {
        return ElementKind.VARIABLE;
    }

    public String getDoc() {
        return PredefinedSymbols.getDocumentation(symbolName);
    }
}
